CuDoubleSidedScannerAPI  1.11
Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerException Class Reference

Scanner Exception class More...

Public Types

enum  ScannerError
 List of managed erros. More...
 

Properties

String ErrorDescription [get]
 Complete error description. Includes a text description and the error code. More...
 
ScannerError ErrorCode [get]
 Returns the ScannerError error code More...
 

Detailed Description

Scanner Exception class

Member Enumeration Documentation

◆ ScannerError

List of managed erros.

Enumerator
ERR_NO 

All OK. No error occurred

ERR_INIT 

An error occurred during library initialization

ERR_OPEN_DEVICE 

Open device error

ERR_INVALID_DEVICE_ID 

Invalid device ID

ERR_DEVICE_NOT_INITIALIZED 

Device not initialized in library. Did you forget ConnectScanner()?

ERR_NULL_OR_INVALID_PARAM 

The received parameter is NULL or invalid

ERR_SMALL_BUFFER 

Data size is bigger than the allocated memory space

ERR_NO_DEVICE_CONNECTED 

No online scanner found

ERR_DEVICE_NOT_FOUND 

The specified scanner has not been found in the scanners list

ERR_NO_DOCUMENT_TO_BE_SCANNED 

No paper has been inserted while scanner motor was on

ERR_NO_SCANNED_DOCUMENT 

No document has been scanned for this side

ERR_INVALID_COMMAND 

The command sent to the scanner is unknown or not valid for the scanner state.

ERR_SCAN_JOB_DOES_NOT_MATCH 

The selected scan job does not match the current scan job.

ERR_SCAN_JOB_OPEN_ERROR 

It's impossible to open/close a job ID.

ERR_UNSUPPORTED_OPTION 

An unsupported option has been selected. See library documentation to know the correct parameter set

ERR_REQUEST_NOT_SUPPORTED 

The request is not supported by the current device. Request not available

ERR_COMMUNICATION 

Indicates an error during the scanner communication

ERR_SCAN_UNKNOWN_ANSWER 

Unknown scanner answer. Scanner answer is not a recognised packet format

ERR_SCAN_DOES_NOT_ANSWER 

The scanner device doesn't answer. Scanner could be offline

ERR_SCANNER_ERROR 

Scanner answer is an error code, or the scanner is in an error state

ERR_WRITE 

Write error

ERR_COMMUNICATION_UNKNOWN_ERROR 

Communication unknown error

ERR_SCAN_UNKNOWN_ERROR 

The scanner returned a recognised error packet, however the specified error is unknown

ERR_PAPER_JAM 

Paper jam

ERR_PAPER_HELD_BACK 

Paper has been held back during scan job

ERR_SCANNER_JAM 

It is not possible to perform or complete the current operation. Scanner jam state

ERR_SCAN_DOUBLE_SHEET 

It is not possible to perform or complete the current operation. Scanner found double sheet

ERR_COMMUNICATION_SYNCHRONIZATION 

Communication synchronization error

ERR_LIBRARY_ALREADY_INITIALIZED 

The library has already been initialized. Please deinitialize the library before continue

ERR_LIBRARY_MISALIGNMENT 

Library function not found. There is a misalignment between libraries. Please update your libraries

ERR_LIBRARY_NOT_LOADED 

Library not loaded

ERR_MISSING_CPP_REDISTRIBUABLE_PACKAGE 

Missing Visual C++ Redistributable Package for Visual Studio 2013

ERR_SCANNER_BUSY 

Scanner busy. Probably a scan job is in progress

ERR_COVER_OPEN 

Impossible to perform the requested operation. The scanner cover is open

ERR_SCAN_INCONSISTENT_DATA 

Data returned by the last/current scan job are inconsistent

ERR_SCAN_IMPEDED 

A trouble impeded to perform a correct scan. (Scan timeout or power supply error)

ERR_SCAN_MICR_NOT_FOUND 

Magnetic ink character recognition failed. Data not found or not detected

ERR_MICR_DETECT_IN_PROGRESS 

Magnetic ink character recognition in progress

ERR_UPG_OPEN_FILE 

Upgrade error: upgrade file not found

ERR_UPG_BOOT_IMAGE_TAG_MISSED 

Upgrade error: boot image tag missed

ERR_UPG_FILE_LEN_NOT_MATCH 

Upgrade error: upgrade file accept length not match

ERR_UPG_WRITE_DATA 

Upgrade error: error in writing upgrade data on scanner

ERR_UPG_WRONG_CHECKSUM 

Upgrade error: checksum error

ERR_UPG_FILE_WRONG_FORMAT 

Upgrade error: file inconsistent. Wrong file format

ERR_VOID_TICKET_NOT_PRESENT 

Void ticket: paper not present on print head. Cannot continue

ERR_VOID_PRINT_HEAD_ERROR 

Void ticket: print head is down. This situation will cause troubles during the next scan job

ERR_DATA_REQ_NO_LONGER_AVAILABLE 

The data requested are no longer available

ERR_OBJECT_OR_MEMORY_ERROR 

Impossible to open a parameter object, or impossible to allocate memory

Property Documentation

◆ ErrorCode

ScannerError Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerException.ErrorCode
get

Returns the ScannerError error code

◆ ErrorDescription

String Custom.CuDoubleSidedScannerAPIWrap.CuDoubleSidedScannerException.ErrorDescription
get

Complete error description. Includes a text description and the error code.